eFAWATEERcom BANK API

(0 reviews)

Prepaid Payment

URLs :

Enviroment	Method	URL
Mock	POST	https://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/efawateercom-bank-exp-api/1.0.20/m/payment/prepaid
Dev	POST	https://maictrldev.capitalbank.jo/efawateercom-bank-api/v1/payment/prepaid
Stage	POST	https://maictrlstg.capitalbank.jo/efawateercom-bank-api/v1/payment/prepaid
Prod	POST	To be updated

Description : This service allows the channel or Bank itself to initiate a Prepaid payment before payment to eFAWATEERcom through Bank Account.

The Bill Payment service for prepaid through account permits Bank and channels to create new prepaid payment record in eFAWATEERcom. The service is intended to involve a set of validations on the received payment, if the validation process is successful,eFAWATEERcom will generate a payment transaction number ‘JOEBPPSTrx’ and return it in the response message to the Bank/PSP. Bank/PSP should get the latest bill details first by sending bill inquiry request.

Mulesoft Request:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id,Authorization

Optional Headers: x-sub-channel-id, x-user-id, client_secret, x-debug-flag, x-customer-id

Request Body: application/json

Field Name	Type	Occurrence	Description
initiation	Object	M
customerId	String	M
debitAmount	Object	O
amount	String	O
currency	String	O
End of debitAmount
creditAmount	Object	M
amount	String	M
currency	String	M	Represents the type of the used currency in payment process
End of debitAmount
debtorIdentifier	Object	M
accountNumber	String	M
End of debtorIdentifier
fx	Object	O
rate	String	O
customerSpread	String	O
End of fx
charges	Array	O
chargeType	String	O
chargeAmount	Object	O
amount	String	O
currency	String	O	Represents the type of the used currency in payment process
End of chargeAmount
End of charges
End of initiation
transactionData	Object	M
debitNarrative	String	O
debitValueDate	String	M
paymentDetails	String	O
channelReference	string	O
End of transactionData
billInformation	Object	M
serviceType	String	M	Represents the service type of the biller
prepaidCat	String	M
validationCode	String	M
dueAmount	String	M
paymentMethod	String	M
accessChannel	String	M	Represents the payment channel type that used to collect payments
billerCode	String	M	Represents the unique code of the Biller Field returned from bill inquiry
billerNumber	String	M
billerCategory	String	M
billerName	String	M
accountInformation	Object	M
billingNumber	String	M	Represents the unique identifier of subscription in a specific service provided by the biller. Field returned from bill inquiry
billNumber	String	M	bill no, Field returned from bill inquiry
End of accountInformation
payerInformation	Object	M
idType	String	O	Represents a unique identifier type (The official number used to identify a customer)
id	String	O	The identification of the customer based on the chosen value from the IdType field
nation	String	O	Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait
name	String	O
phone	String	O
address	String	O
email	String	O
joebppsNo	String	O	Represents the unique identifier of the customer profile in eFAWATEERcom
End of 'payerInformation' container
End of 'billInformation' container

{
    "initiation": {
      "customerId": "2000565",
      "debitAmount": {
        "amount": "",
        "currency": ""
      },
      "creditAmount": {
        "amount": "5",
        "currency": "JOD"
      },
      "debtorIdentifier": {
        "accountNumber": "4000890"
      },
      "fx": {
        "rate": "",
        "customerSpread": ""
      },
      "charges": [
        {
          "chargeType": "ECOM",
          "chargeAmount": {
            "amount": "5",
            "currency": "JOD"
          }
        }
      ]
    },
    "transactionData": {
      "debitNarrative": "fdgf",
      "debitValueDate": "20210101",
      "paymentDetails": "mmmmm",
      "channelReference": "madfooat"
    },
    "billInformation": {
      "serviceType": "LeasedLine",
      "prepaidCat":"payment",
      "validationCode":"1234",
      "dueAmount":"10",
      "paymentMethod":"ACTDEB",
      "accessChannel": "INTERNET",
      "billerCode": "1411",
      "billerNumber": "343334",
      "billerCategory": "tesss",
      "billerName": "test",
      "accountInformation": {
        "billingNumber": "22552",
        "billNumber": "22552"
      },
      "payerInformation": {
        "idType": "",
          "id": "",
          "nation": "",
          "name": "",
          "phone": "",
          "address": "",
          "email":"",
        "joebppsNo": "1733925"
      }
    }
  }

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field Name	Type	Length	Occurrence	Description	Validations
status	Object		M
success	Boolean		M	true false
code	String	10	M	Error Code	“0” incase of success or Error Code
reasonCode	String	50	O	Error Type or Error category	Add this tag only incase of error
arabicMessage	String	200	M	English message translated to Arabic	تمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessage	String	200	M	Description about the processing	“The Operation has been Successfully Completed” Or error Description
End of status
response	Object		O		Exists if success = true
transactionReference	String		M		transaction Id when the fund transaction will get created successfully
joebppsTrx	String		M		joebppsTrx when the fund transaction will get created successfully

{
  "status": {
    "success": true,
    "code": "200",
    "reasonCode": "reason code",
    "arabicMessage": "تمت العملية بنجاح",
    "englishMessage": "The Operation has been Successfully Completed"
  },
  "response": {
    "transactionReference": "FT03043523",
    "joebppsTrx": "FT03043523"
  }
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
   "success": false,
   "code": "400",
   "reasonCode": "Bad Request",
   "arabicMessage": "اقتراح غير جي",
   "englishMessage": "paymentMethod is invalid"
}

Prepaid Payment

Reviews